home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / INPUT / POINTABL.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  2.3 KB  |  61 lines
  1. package sub_arctic.input;
  2.  
  3. /**
  4.  * This is an input protocol interface useful for performing actions on the 
  5.  * interface when the mouse enters or leaves an object. <P>
  6.  *
  7.  * <STRONG>Warning</STRONG>: This protocol is based on the various mouse
  8.  * events that are dispatched by the system. If you modify an interface
  9.  * based on other types of events (e.g. animation), the pointable
  10.  * interface's mouse_exit() call will not be made immediately. In particular,
  11.  * such a call will not be made until the next mouse event is processed.
  12.  *
  13.  * @author Ian Smith
  14.  */
  15. public interface pointable {
  16.  
  17.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  18.  
  19.   /**
  20.    * This method is called when the pointer enters you area and
  21.    * when no other agent has dispatched the event.
  22.    * @param event  evt       the event to dispatch
  23.    * @param Object user_info the object you passed to the pick_collector 
  24.    *                         at pick_time
  25.    * @return boolean return true if you dispatched this event
  26.    */
  27.   public boolean mouse_enter(event evt, Object user_info);
  28.  
  29.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  30.  
  31.   /**
  32.    * This method is called when the pointer leaves your area. Note that
  33.    * no user_info is given to you, you were not picked by this event!
  34.    * Also, beware that you cannot return a value from this function,
  35.    * because it is not only possible but likely that some other
  36.    * part of the system handled this event.  
  37.    *
  38.    * @param event evt the event to dispatch
  39.    */
  40.   public void mouse_exit(event evt);
  41.   //xx need to do something to make this consistent with other input protocols
  42.  
  43.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  44. }
  45. /*=========================== COPYRIGHT NOTICE ===========================
  46.  
  47. This file is part of the subArctic user interface toolkit.
  48.  
  49. Copyright (c) 1996 Scott Hudson and Ian Smith
  50. All rights reserved.
  51.  
  52. The subArctic system is freely available for most uses under the terms
  53. and conditions described in 
  54.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  55. and appearing in full in the lib/interactor.java source file.
  56.  
  57. The current release and additional information about this software can be 
  58. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  59.  
  60. ========================================================================*/
  61.